groundsdk 7.7.2 API/com.parrot.drone.groundsdk.plan/Plan

Plan

data class Plan(val staticConfig: Plan.StaticConfig? = null, val items: List<Plan.Item>)

Plan file representation.

Parrot Plan format documentation

Parameters

staticConfig

static config of the plan, null if none

items

list of items of the plan

Constructors

constructor(staticConfig: Plan.StaticConfig? = null, items: List<Plan.Item>)

Types

interface Item

class ParseException(cause: Throwable) : RuntimeException

Exception thrown whenever parsing a plan file format fails.

data class StaticConfig(var customRth: Boolean? = null, var rthType: ReturnHomePilotingItf.Target? = null, var rthAltitude: Double? = null, var rthEndAltitude: Double? = null, var disconnectionPolicy: FlightPlanPilotingItf.DisconnectionPolicy? = null, var rthEndingBehavior: ReturnHomePilotingItf.EndingBehavior? = null, var digitalSignature: Camera.DigitalSignature? = null, var customId: String? = null, var customTitle: String? = null)

Static config of a plan.

Properties

val Plan.commands: List<MavlinkCommand>

Convenience function that provides a list of all plan commands, in order.

val Plan.configs: List<Plan.Item.Config>

Convenience function that provides a list of all plan item configs, in order.

val items: List<Plan.Item>

val staticConfig: Plan.StaticConfig? = null

Functions

fun Plan.generateTo(output: OutputStream, groundStationName: String)

Serializes a plan to a given output stream.